docs: consolidate contributor and architecture guidance#897
Merged
gildesmarais merged 3 commits intomainfrom Mar 21, 2026
Merged
docs: consolidate contributor and architecture guidance#897gildesmarais merged 3 commits intomainfrom
gildesmarais merged 3 commits intomainfrom
Conversation
gildesmarais
force-pushed
the
pr/docs-canon
branch
from
1445d0a to
b7f7a9a
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates contributor/agent guidance into a single canonical docs structure, adds onboarding-friendly architecture and request-lifecycle documentation, and trims top-level entrypoints to point at the new docs.
Changes:
- Update root README to link to canonical contributor docs and add a minimal “docker run” trial flow.
- Expand
docs/README.mdinto the canonical contributor guide (setup, contract loop, testing layers, constraints). - Add new onboarding docs for architecture/request lifecycle and UI/design rules; slim down agent instruction entrypoints to redirect to canonical docs.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Points contributors to canonical docs and adds a minimal “docker run” trial path. |
| docs/README.md | Becomes the canonical contributor guide (commands, contract loop, constraints, env table). |
| docs/design-system.md | New design-system manifesto consolidating UI/CSS rules. |
| docs/architecture.md | New architecture + request-lifecycle overview for onboarding. |
| AGENTS.md | Refocuses on agent constraints and redirects general guidance to canonical docs. |
| .github/copilot-instructions.md | Replaces embedded rules with pointers to canonical docs for AI agents. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification